home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 2 / Meeting Pearls Vol. II (1995)(GTI - Schatztruhe)[!].iso / Pearls / dev / GUI / BGUI / bgui.doc < prev    next >
Text File  |  1994-10-09  |  36KB  |  845 lines
  1.  
  2.  
  3. `BGUI' release 1.0
  4. ******************
  5.  
  6. Preface
  7. *******
  8.  
  9.                                 `BGUI' release 1.0
  10.                     (C) Copyright 1993-1994  Jaba Development
  11.                     (C) Copyright 1993-1994 Jan van den Baard
  12.                           Written using  DICE v3.0 by
  13.      
  14.                         SNail: Jan van den Baard
  15.                                Bakkerstraat  176
  16.                                3082 HE Rotterdam
  17.                                     Holland
  18.      
  19.                      Fido: 2:286/407.53  (Jan van.den.Baard)
  20.                            EMail: jaba@grafix.wlink.nl
  21.      
  22.                               EMail is preferred.
  23.                If you must use snail mail then please make it clear
  24.                when you absolutely need an anwser and (don't forget
  25.                       this) include enough return postage.
  26.      
  27.                                   User Manual
  28.                      (C)Copyright 1993-1994 Jaba Development
  29.                                          __  __
  30.                                         / / /  \
  31.                                  __    / / / /\ \
  32.                             _____\ \__/ /_/ /_/ /_____
  33.                            (__________________________)
  34.  
  35.    `BGUI',  (C) Copyright 1993-1994 Jaba Development. All rights reserved. This
  36. program is GiftWare. This means that if you want to use the programs you are
  37. morally obligated to reward the author with a gift that, you think, matches
  38. his efforts. If you cannot think of a gift (come on! be creative ;), a small
  39. financial donation will always be gladly accepted.
  40.  
  41.    I have thought about how to release this package for quite some time. My
  42. initial thought went out to shareware but I soon forgot about this. Since most
  43. of the libraries of this kind seem to be shareware I do not think that many
  44. people like this simply because it's anoying to have to pay for a library if
  45. you had to pay for the application as wel.
  46.  
  47.    To avoid these problems I have decided to release this package as giftware
  48. for people writing freely distributable software. With "freely distributable
  49. software" I mean non-crippeled, free of charge software. Authors who wish to
  50. use `BGUI' in shareware and/or commercial programs must pay for the usage of
  51. `BGUI' before actually using it.
  52.  
  53.    ShareWare and/or commercial usage is `not' allowed without:
  54.  
  55.       1) Prior written permission from the author.
  56.       2) A small finacial donation of US$ 20,-, DM 30,- or HFL 30,-.
  57.       3) A free and registered copy of the product including free updates that
  58.          still make use of the library.
  59.  
  60.    The idea behind this distribution policy is simple. You make money with the
  61. aid of `BGUI'? I want to get my (very humble) share.
  62.  
  63.    This software is not crippeled so when you register it you will not recieve
  64. a key-file or an updated version. Registering simply buys you the right to use
  65. this software in shareware and/or commercial applications.
  66.  
  67.    Resonable, eh?
  68.  
  69. Introduction
  70. ************
  71.  
  72.    `BGUI' is a BOOPSI based shared library contaning a number of BOOPSI
  73. classes.  It allows for easy creation and managing of font sensitive and size
  74. adjustable GUI's on the Amiga. Hmm, where have I read something like this
  75. before..., I hear you say.
  76.  
  77.    YES! This is yet another GUI library. I know there has been a lot of
  78. discussions about the usabillity and neccesity of GUI libraries on the nets
  79. lately. Still, being the ignorant bugger that I am, at some point I felt it
  80. was necessary to write yet another one.
  81.  
  82.    Believe me when I say that `BGUI' was not intended to become a releasable
  83. project. I started coding `BGUI' simply because I was amazed what MUI did
  84. using BOOPSI. Therefore I started coding some BOOPSI classes as a learning
  85. experience.
  86.  
  87.    Hmmm... This is beginning to sound like an excuse... As if I did something
  88. terrible ;)
  89.  
  90.    The point is that, while working on BGUI, I saw many GUI libraries being
  91. released and not one of them really seemed to take off. This made me think
  92. that all this talk about "For every app I run I need to install a different
  93. GUI library" really is bull. Please correct me if I'm wrong but I have yet to
  94. see a program requiring a GUI library (with the exception of MUI ofcourse).
  95.  
  96.    Sure there are a lot available but MUI is the only one which actually seems
  97. to be used by the programmers.
  98.  
  99.    This is the reason for `BGUI'. I have tryed to create a library which does
  100. it's thing simular to MUI eliminating the biggest problems that programmers
  101. seem to have with MUI. Meaning no fancy
  102. background-pen-frame-text-image-whatever settings editor, not a zillion extra
  103. images, no external class libraries etc.
  104.  
  105.    `BGUI' is a single library which can be removed as easely as it can be
  106. installed. It provides an easy way to create and control GUI's without becoming
  107. excessive in what it does.
  108.  
  109.    I guess time will tell if `BGUI' is going to be accepted or not...
  110.  
  111. Features
  112. ********
  113.  
  114.    * Requires at least OS 2.04 (Yes, that is a feature :)
  115.  
  116.    * Extends on the existing system gadgetclass and rootclass.
  117.  
  118.    * Creates completely font sensitive GUI's.
  119.  
  120.    * Supports sizable windows.
  121.  
  122.    * AppWindow support.
  123.  
  124.    * Titled group-frames and seperators.
  125.  
  126.    * Supports OS 3.0 when available.
  127.  
  128.    * Style Guide compliant.
  129.  
  130.    * Keyboard control of most gadget classes.
  131.  
  132.    * Several types of notification to create "self driven" GUI's.
  133.  
  134.    * Easy intergration of third-party classes.
  135.  
  136.    * Easy to make your class work directly with BGUI.
  137.  
  138.    * Object oriented.
  139.  
  140.    * Resonable speed, even with a 68000 processor.
  141.  
  142.    * Relatively small library.
  143.  
  144.    * Classes for easy filerequester and commodity creation.
  145.  
  146.    * Seperate ARexx class including source code.
  147.  
  148. Requirements
  149. ************
  150.  
  151.    `BGUI' requires at least version 2.04 of the operating system. It does `not'
  152. run on 1.3 systems. Are there still people running 1.3?
  153.  
  154.    `BGUI' also requires the following disk-based libraries to operate:
  155.  
  156.    * gadtools.library          (V37)   (menus)
  157.  
  158.    * asl.library               (V37)   (filereq class)
  159.  
  160.    * commodities.library       (V37)   (commodities class)
  161.  
  162.    The following libraries are not required but they will impose on the
  163. functionality of the library when not available:
  164.  
  165.    * locale.library            (V38)   (localized library strings)
  166.  
  167.    * amigaguide.library        (V37)   (On-line help)
  168.  
  169.    * workbench.library         (V37)   (App-window support)
  170.  
  171.    It should not be a problem to use BGUI on a system with 512KByte but a
  172. minimum of 1 Megabyte is suggested as a minimum.
  173.  
  174. Installation
  175. ************
  176.  
  177.    The installation of BGUI is very simple. You can either use the Installer
  178. utility by C= which will install the library for you or you can copy the
  179. `bgui.library' to your LIBS: directory or into a directory you might have
  180. setup for non-system libraries.
  181.  
  182.    Where you put the headers/modules for the language you use is up to you.
  183. Since the different compilers and users use different directory structures I
  184. did not supply a script for you to install these. You'll have to do this by
  185. hand.
  186.  
  187. Read Me
  188. *******
  189.  
  190.    * The bgui.library is a special library in the sence that it is a single
  191.      task library.  This means that `every' task using the library must open
  192.      the library for itself.  The library base pointer may `not' be shared
  193.      between different tasks.
  194.  
  195.      The reason for this is that the library tracks information like window
  196.      bounds etc.  This tracking is done for each individual task.
  197.  
  198.      So if your code spawns a sub-task which needs the library, the sub-task
  199.      code must open the library for itself. It may not share it with the main
  200.      task.
  201.  
  202.    * The object ID's (gadgets and menus) are restricted to the range 1..65535.
  203.      ID's smaller or larger than this are not allowed. This should not be a
  204.      problem :)
  205.  
  206.    * When designing custom classes to work with BGUI please try to keep your
  207.      tag values and method ID's well out of the range of the BGUI tag values
  208.      and method ID's. Using values that conflict with the BGUI values may have
  209.      unexpected results.
  210.  
  211. Keyboard & Mouse
  212. ****************
  213.  
  214.    Most of the BGUI gadget objects can be controlled by the keyboard. Usually
  215. the key that is used to control an object is shown by an underlined character
  216. in the object it's label. The objects can be controlled as follows:
  217.  
  218.    * `Button' - Pressing the key will make the object appear pressed. If you
  219.      release the key the object appears normal again and the application is
  220.      signalled that the object was selected. When you accidentally activated
  221.      the button you can press SHIFT or ESC before releasing the key to cancel
  222.      the selection.
  223.  
  224.    * `Toggle Button' - Pressing the key will toggle the selected state of the
  225.      toggle button.
  226.  
  227.    * `CheckBox' - Pressing the key will toggle the selected state of the
  228.      checkbox object.
  229.  
  230.    * `Prop (Scroller)' - Pressing the key will advance the knob position by
  231.      one page. When you press the key together with SHIFT the knob will backup
  232.      one page. You can reset the knob position when you are dragging the knob
  233.      with the mouse by clicking on the right mouse button.
  234.  
  235.    * `Listview' - Pressing the key will select the next entry in the list
  236.      scrolling the entries when necessary. Pressing the key together with
  237.      SHIFT will select the previous entry. Read only listview objects will
  238.      simply scroll the list forward and backward.
  239.  
  240.    * `Cycle' - Pressing the key will cycle one choise forward. Pressing the
  241.      key together with SHIFT will cycle one choise backward. Selecting the
  242.      gadget with the mouse while holding down the SHIFT key will also make the
  243.      gadget cycle backward. When the cycle gadget was setup to be a popup
  244.      gadget by the application programmer you can click inside the label area
  245.      to pop-up a menu from which you can select the desired item. You can
  246.      recognize a popup gadget by the imagery left of the label area. Normal
  247.      cycle gadgets have a circular arrow here and popup gadgets have a small
  248.      menu here.
  249.  
  250.    * `Slider' - Pressing the key will advance the knob position by one.
  251.      Pressing the key together with shift will decrease the knob position by
  252.      one. You can reset the knob position when you are dragging the knob with
  253.      the mouse by clicking to on the right mouse button.
  254.  
  255.    * `String,Integer' - Pressing the key will simply activate the gadget.
  256.  
  257.    As you can see this behaviour is mostly style guide compliant with some
  258. additional possibilities.
  259.  
  260. Disclaimer
  261. **********
  262.  
  263.    THERE IS NO WARRANTY FOR THE PROGRAMS, TO THE EXTENT PERMITTED BY
  264. APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS
  265. AND/OR OTHER PARTIES PROVIDE THE PROGRAMS "AS IS" WITHOUT WARRANTY OF ANY
  266. KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  267. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE
  268. ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAMS IS WITH YOU.
  269. SHOULD THE PROGRAMS PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
  270. SERVICING, REPAIR OR CORRECTION.
  271.  
  272.    IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
  273. ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAMS AS
  274. PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  275. INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  276. THE PROGRAMS (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
  277. INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
  278. PROGRAMS TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
  279. PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  280.  
  281. License
  282. *******
  283.  
  284.    This license applies to the product called `BGUI', a program for the Amiga
  285. computer, published by Jan van den Baard under the concepts of GiftWare, and
  286. the accompanying documentation, example files and anything else that comes
  287. with the original distribution. The term "Program" below, refer to this
  288. product. The term "Author" below, refers to "Jan van den Baard". The license
  289. is addresses as "you".
  290.  
  291.    * You may copy and distribute verbatim copies of the program's executable
  292.      code and documentation as you receive it, in any medium, provided that
  293.      you conspicuously and appropriately publish only the original, unmodified
  294.      program, with all copyright notices and disclaimers of warranty intact
  295.      and including all the accompanying documentation, example files and
  296.      anything else that came with the original.
  297.  
  298.    * You may not copy and/or distribute this program without the accompanying
  299.      documentation and other additional files that came with the original. You
  300.      may not copy and/or distribute modified versions of this program.
  301.  
  302.    * You may not copy, modify, sublicense, distribute or transfer the program
  303.      except as expressly provided under this license.  Any attempt otherwise
  304.      to copy, modify, sublicense, distribute or transfer the program is void,
  305.      and will automatically terminate your rights to use the program under
  306.      this license.  However, parties who have received copies, or rights to
  307.      use copies, from you under this license will not have their licenses
  308.      terminated so long as such parties remain in full compliance.
  309.  
  310.    * By copying, distributing and/or using the program you indicate your
  311.      acceptance of this license to do so, and all its terms and conditions.
  312.  
  313.    * Each time you redistribute the program, the recipient automatically
  314.      receives a license from the original licensor to copy, distribute and/or
  315.      use the program subject to these terms and conditions.  You may not
  316.      impose any further restrictions on the recipients' exercise of the rights
  317.      granted herein.
  318.  
  319.    * You may not disassemble, decompile, re-source or otherwise reverse
  320.      engineer the program.
  321.  
  322.    * You are free to use the programs. If, after an evaluation period of up to
  323.      30 days, you find the programs useful enough to continue using them you
  324.      are morally, not lawfully, obligated to send the author a gift that, you
  325.      think, matches his efforts. Shareware or commercial usage of the programs
  326.      require registering. Please refer to the *note Preface::.  section for
  327.      more information on registering.
  328.  
  329.    * If you wish to incorporate parts of the programs into other programs,
  330.      write to the author to ask for permission. If you want to release your
  331.      programs as being Public Domain, FreeWare or GiftWare you are allowed to
  332.      include a copy of the "bgui.library" without the accompaning
  333.      documentation and files. ShareWare and Commercial distribution of the
  334.      programs is not allowed without prior written permission. Please refer to
  335.      the *note Preface::. section for more information on registering.
  336.  
  337.    * You agree to cease distributing the program and data involved if
  338.      requested to do so by the author.
  339.  
  340.    * You may charge a fee to recover distribution costs. The fee for diskette
  341.      distribution may not be more than the cost to obtain a public domain
  342.      diskette from Fred Fish.
  343.  
  344. History
  345. *******
  346.  
  347. V37.11
  348. ======
  349.  
  350.    * Started written history...
  351.  
  352.    * Added the PROGRESS_Divisor tag for those extremely large values.
  353.  
  354.    * BUG FIX: The progress class object could fill the gauge 1 pixel to far in
  355.      some cases. Added some extra code to prevent this from happening.
  356.  
  357.    * Added the external class. This class makes it easy to include third party
  358.      classes like the colorwheel.gadget in a BGUI user interface. Still have
  359.      major problems handling notification though...
  360.  
  361.    * Added the WM_ADDUPDATE method to the window class. This method makes it
  362.      possible to connect an external class object to another object to perform
  363.      simple icclass style notification.
  364.  
  365. V37.12
  366. ======
  367.  
  368.    * BUG FIX:  The layout engine sometimes layouted an object one or two
  369.      pixels to small. Added some extra code to prevent this from happening.
  370.  
  371.    * Added the LGO_Align attribute to enhance the layout procedure.
  372.  
  373.    * BUG FIX: The stringclass screwed up in computing it's minimum size when
  374.      it did not have a frame attached to it.
  375.  
  376.    * BUG FIX: The layout engine sometimes GURU'd. Ooops. Should be fixed now.
  377.  
  378.    * BUG FIX: The LISTV_RenderHook did not setup the entry correctly in the
  379.      lvRender structure.
  380.  
  381.    * Added the LVM_REMENTRY method which can be used to remove single entries
  382.      from a listview.
  383.  
  384.    * Added the LVM_REFRESH method to refresh the listview object after
  385.      adding/removing some entries.
  386.  
  387.    * BUG FIX: The infoclass computed the maximum width of the formatted text
  388.      one pixel to small.
  389.  
  390. V37.13
  391. ======
  392.  
  393.    * BUG FIX: The window class did not succeed in opening a screen size window
  394.      when the screen was smaller than it's default size.
  395.  
  396.    * BUG FIX: The listview class did not refresh the list correctly when a
  397.      single entry was added.
  398.  
  399.    * BUG FIX: Fixed the AddEntryVisible macro in bgui_macros.h.
  400.  
  401.    * BUG FIX: Fixed a couple of bugs in the string class. Bugs found by Paul
  402.      weterings.
  403.  
  404.    * BUG FIX: The Toggle() and KeyToggle() macros from bgui_macros.h did not
  405.      make it possible to set a toggle button selected by default. Note that
  406.      these macros require an additional parameter now. Bug found by Paul
  407.      Weterings.
  408.  
  409. V37.14
  410. ======
  411.  
  412.    * BUG FIX: The online-help system of the gadget objects did not work at all.
  413.  
  414.    * BUG FIX: The drop-box frame used incorrect spacing when the
  415.      FRF_THIN_FRAME flag was set.  The radio-button frame totally ignored the
  416.      FRF_THIN_FRAME flag. Bugs found by Paul Weterings.
  417.  
  418.    * Added the LISTV_TitleHook attribute to the listview class. This hook
  419.      makes it possible to render a title entry in the listview object. Can
  420.      come in handy with multi-column listviews.
  421.  
  422.    * Re-arranged and adjusted the source for DICE V3.0 commercial. Boy oh boy
  423.      it really is picky about correct prototyping now...
  424.  
  425.    * The list class now uses the memory pool routines from the 3.1 amiga.lib.
  426.      This means working memory pools even on 2.04.
  427.  
  428.    * BUG FIX: The group class did not always yield the correct results when
  429.      requesting the minimum size of another group. This resulted in a
  430.      wrong-sized mx object when it had a label attached to it.
  431.  
  432. V37.15
  433. ======
  434.  
  435.    * Added task-relative information tracking. This means that from now on the
  436.      library is a `SINGLE-TASK-LIBRARY'. If your code spawns a sub-task that
  437.      requires the use of `BGUI' then this sub-task must open the library
  438.      itself. It may not share the base pointer with the main-task.
  439.  
  440.    * Added the WINDOW_UniqueID attribute to give a window a unique ID of your
  441.      choise. This ID is used by the task-relative information tracking to
  442.      store the window size/position even when you dispose of the object and
  443.      re-generate it.
  444.  
  445.    * Added the LVM_SORT method for re-sorting the entries in a listview
  446.      object. Also added the SortList() macro in bgui_macros.h for this purpose.
  447.  
  448.    * Made the flag bits of the frameclass and labelclass also available as
  449.      boolean tags. This allows for easier switching of single flags.
  450.  
  451.    * BUG FIX: The lvma_Entry field of the lvmAddSingle structure was defined
  452.      as (APTR *) while it should be (APTR).
  453.  
  454. V37.16
  455. ======
  456.  
  457.    * You can now reset the knob of a sliderclass or propclass object to it's
  458.      initial setting by pressing the right mouse button before releasing the
  459.      left-button.
  460.  
  461.    * Added the WINDOW_Window attribute to enable you to obtain a pointer to
  462.      the window structure of a windowclass object.
  463.  
  464.    * Started keeping up with the source code revisions using the Revision
  465.      Control System (RCS) supplied with DICE 3.0.
  466.  
  467. V37.17
  468. ======
  469.  
  470.    * BUG FIX: The buttonclass now takes the design size of a vectorclass image
  471.      into consideration when computing it's minimum size. Bug found by Wouter
  472.      van Oortmersen.
  473.  
  474.    * BUG FIX: Fixed the rendering bug of objects on invisible pages. Bug found
  475.      by Paul Weterings.
  476.  
  477.    * BUG_FIX: Fixed the enforcer hits of Infoclass objects in a Pageclass
  478.      object. Bug found by Paul Weterings.
  479.  
  480.    * Added a XEN style button frame to the frame class. Also added some new
  481.      macros to the bgui_macros header specially for this purpose.
  482.  
  483.    * Added XEN macros in the bgui_macros.h file for the checkbox and cycle
  484.      objects.
  485.  
  486.    * Added the GROUP_BackFill attribute to supply a group backfill possibility
  487.      without a group frame.
  488.  
  489.    * Added the BREQF_XEN_BUTTONS flag to supply the requester buttons with a
  490.      XEN style frame.
  491.  
  492. V37.18
  493. ======
  494.  
  495.    * BUG FIX: The infoclass sometimes screwed up with text-styles. I'm not
  496.      sure if this was a bug in the infoclass itself but I have coded a
  497.      work-around to the problem.
  498.  
  499.    * Optimized setting pens and drawmode in a rastport. Now the code checks
  500.      the pens and drawmode to see if it needs to change. Should speed up the
  501.      rendering somewhat.
  502.  
  503.    * BUG FIX: When flushing the library from memory while one or more of the
  504.      classes failed to free could result in a GURU. This should not happen
  505.      anymore.
  506.  
  507.    * Added the seperator class which adds the possibility to seperate groups
  508.      with a single 3D line with or without a title. Also added a couple of
  509.      macros to bgui_macros.h for this purpose.
  510.  
  511. V37.19
  512. ======
  513.  
  514.    * BUG FIX: The stringclass by default used the wrong pens to render it's
  515.      contents. Now the correct pens are used by default keeping track of user
  516.      set pens.
  517.  
  518.    * Added some simple macros for NewMenu definitions in the bgui_macros.h
  519.      header.
  520.  
  521.    * BUG FIX: Drag-selecting menus would result in replying a non-existant
  522.      IntuiMsg (enforcer hits...  GURUs... `ouch!')
  523.  
  524.    * BUG FIX: Fixed a bug that caused rendering object labels in the wrong
  525.      color when the object was selected and the label was located outside the
  526.      object hit area.
  527.  
  528.    * BUG FIX: The HorizSlider() macro was broken.
  529.  
  530.    * BUG_FIX: Some classes screwed up computing their minimum size when the
  531.      label was located above or below the object. This should not happen
  532.      anymore.
  533.  
  534.    * Extended the Listview class rendering hook result code. When the hook
  535.      returns non-NULL the class will see this as a string and render it. A
  536.      result code of NULL is ignored. Please read the LISTV_DisplayHook section
  537.      of the listviewclass.doc file for more information on this subject.
  538.  
  539.    * Added hook-notification to the baseclass. Please refer to the
  540.      baseclass.doc file for more information on this subject.
  541.  
  542.    * BUG FIX: Fixed a small bug in the tab-cycling code of the string class.
  543.      The bug caused non-tabcycling gadgets to notify the event-handler when it
  544.      was de-activated.
  545.  
  546.    * BUG FIX: The AddEntrySelect() macro was broken.
  547.  
  548.    * Added the LVM_LOCKLIST and LVM_UNLOCKLIST methods to the listview class.
  549.      These methods should have been in there from the beginning to prevent
  550.      strange results when somebody is fiddling with the listview while you are
  551.      changing one of it's entries.
  552.  
  553.    * BUG FIX: While converting a text-editor I'm writing to `BGUI' I came
  554.      accross a buch of small bugs bugs in `BGUI'. These (I shall not list
  555.      them) should be fixed now.
  556.  
  557.    * BUG FIX: When using a shared window port for the `BGUI' windows it would
  558.      happen that the event handler did not get the initial IDCMP_ACTIVEWINDOW
  559.      message because the port is added to the window after it is opened. Now
  560.      the code will manually activate the window when the WA_Active tag is TRUE
  561.      after the port has been added.
  562.  
  563. V37.20
  564. ======
  565.  
  566.    * Changed the behaviour of the WINDOW_UniqueID tag when the
  567.      WINDOW_PosRelBox tag is also used.  Please refer to the WINDOW_UniqueID
  568.      section of the windowclass.doc file for more information.
  569.  
  570.    * Added some extra code to ensure that the window sizing-gadget size is
  571.      computed correctly. This will ensure the correct operation with patches
  572.      like SysIHack. One note about SysIHack... When using the PGA_NewLook
  573.      feature SysIHack renderes the proportional gadget left&and up from the
  574.      intended location and to big and it ignores the PGA_Borderless tag. I
  575.      would report this to the author of SysIHack if only I knew who Mr. BOOPSI
  576.      was :)
  577.  
  578.    * BUG FIX: The progress class now checks frame thickness before filling the
  579.      indicator.
  580.  
  581.    * BUG FIX: Fixed the PACKPENS() macro in bgui_macros.h. Docs clearly state
  582.      "packed as two WORDs into a longword" but as it seems it should be two
  583.      bytes in a word? Am I wrong???
  584.  
  585.    * BUG FIX: After testing BGUI on another public screen with a BACKGROUNDPEN
  586.      different from 0 it came to my attention that BGUI had some problems with
  587.      this. Now all rendering should occure OK with a different BACKGROUNDPEN
  588.      than 0. I have fixed the labelclass and vectorclass and added a
  589.      backfill-hook (WA_BackFill) to the windowclass to fix these problems.
  590.  
  591.    * Added a pop-up menu option to the cycle class. Also added a couple of new
  592.      macros to bgui_macros.h to support this new option. Suggested by Jim
  593.      Cooper.
  594.  
  595.    * The infoclass does not clip the text anymore when it won't fit. Now it
  596.      simply renders as much text as will fit in the area.
  597.  
  598.    * Removed the text class completely. It was not a necessary class since the
  599.      infoclass can do the most important things that the text class could do.
  600.      The info class even does a better job at it. This also means that I
  601.      finally got rid of all rastport-clipping.
  602.  
  603.    * The complete GUI is rendered in a buffer bitmap so that it can be made
  604.      visible in a single blit. This looks much smoother than rendering visible
  605.      on-screen. If a buffer cannot be allocated the rendering occures
  606.      on-screen.
  607.  
  608.    * BUG FIX: It was possible to size an empty group to 0x0 which lead to
  609.      potentially dangerous situations. I have made all RectFill() that are
  610.      performed safe which means that the rectangle specified is checked for
  611.      wierd values.
  612.  
  613. V37.21
  614. ======
  615.  
  616.    * Changed the imagery of the cycle gadget when it is in Popup mode. It is
  617.      not the best of imagery but it works. If anybody has a better idea let me
  618.      know.
  619.  
  620.    * BUG FIX: A window with an ID and positioned relative to a rectangle would
  621.      be placed wrong if the window was to big for the used font. This does not
  622.      happen anymore but windows which grow to big for the used font and have
  623.      to use the fall-back font will not remember it's size.
  624.  
  625.    * BUG FIX: Fixed a big-fat-stupid-lame-bug in the external class. I failed
  626.      to aply rule number one when writing a BOOPSI dispatcher by not using the
  627.      __geta4 (__saveds) qualifier.  Bug found by Paul Weterings.
  628.  
  629.    * BUG FIX: Using a frame and/or a label on the master-group caused the
  630.      rendering of this frame and/or label to be overwritten. Bug found by Paul
  631.      Weterings.
  632.  
  633.    * Changed Xen frame rendering so that you get "rounded" corners. Looks much
  634.      better.
  635.  
  636.    * Made the LISTV_Top attribute gettable as it should have been al along.
  637.  
  638.    * BUG FIX: Some IDCMP bits where not accessable with an IDCMP hook. Should
  639.      be fixed now.
  640.  
  641.    * Added the EXT_NoRebuild attribute to handle external gadgetclasses which
  642.      are smart enough to handle a resize themselves. Suggested by Paul
  643.      Weterings.
  644.  
  645.    * BUG FIX: The stringclass rendered through the active page when it's
  646.      contents was changed.  This also happened when the gadget was not located
  647.      on the active page. Bug found by Paul Weterings.
  648.  
  649.    * Added a method to the groupclass to insert members at any place into an
  650.      already existing group. Suggested by Paul Weterings.
  651.  
  652.    * The cycleclass notification (in popup mode) is now delayed until the menu
  653.      window is closed. Suggested by Paul Weterings.
  654.  
  655.    * The pageclass now also renders the current page in a buffer before it is
  656.      shown. Note that this is only true when the page to show is a group.
  657.      Suggested by Paul Weterings.
  658.  
  659. V37.22
  660. ======
  661.  
  662.    * BUG FIX: LISTV_MakeVisible and LISTV_Select did not make the item
  663.      visible. Bug found by Paul Weterings.
  664.  
  665.    * Added a couple of macros to create non-fixed size checkbox objects.
  666.      Suggested by Paul Weterings.
  667.  
  668.    * Made the WINDOW_Screen and WINDOW_PubScreenName settable when the window
  669.      is closed. Suggested by Paul Weterings.
  670.  
  671.    * BUG FIX: The Popup menu of a Popup-Cycle object would not open on the
  672.      correct screen when the window in which it resided was not located on the
  673.      default public screen. Bug found by Paul Weterings.
  674.  
  675.    * BUG FIX: Erasing the title area of a seperatorclass object did not yield
  676.      the desired result when the area-pattern of the rastport was not cleared.
  677.  
  678.    * BUG FIX: After running tests with memoration it came to my attention that
  679.      the re-size oprations where not working properly if the buffer rastport
  680.      could not be allocated.
  681.  
  682. V37.23
  683. ======
  684.  
  685.    * Enhanced listview class scrolling a bit. The old routines had a lot of
  686.      overhead because they simple re-rendered the complete list even if the
  687.      top only changed one or two places.
  688.  
  689.    * Switching pages in a pageclass object looks smoother now.
  690.  
  691.    * Most small allocations are now made in memory pools instead of allocating
  692.      them directly from the system memory pool.
  693.  
  694.    * Changed the operation of the WINDOW_SigMask, WINDOW_AppMask and
  695.      COMM_SigMask attributes. Instead of OR'ing the mask value to the storage
  696.      field the mask value is set now.
  697.  
  698.    * Added the WINDOW_Bounds attribute which can be used to open a window at
  699.      the place and width the size that you want. Suggested by Paul Weterings.
  700.  
  701.    * Initial Public Beta Release... (30.09.94)
  702.  
  703. V37.24
  704. ======
  705.  
  706.    * Added the BT_HelpText and WINDOW_HelpText attributes to pop a requester
  707.      with a help text instead of having to use AmigaGuide. for small help.
  708.      This also results in a new BGUI catalog (version 2).
  709.  
  710.    * BUG FIX: BGUI did not recognize language changes. Now each time BGUI
  711.      needs to access localized strings the catalog is refreshed before
  712.      actually accessing the strings. This results in the strings always being
  713.      in the preferred language.
  714.  
  715.    * Added the GROUP_EqualWidth and GROUP_EqualHeight attributes to make the
  716.      members of a group all have the same minimum width and or height.
  717.  
  718.    * Made the WINDOW_Bounds attribute settable with OM_SET. You can set it
  719.      when the window is closed or opened. Suggested by Paul Weterings.
  720.  
  721. Future
  722. ******
  723.  
  724.    This is a list of known bugs and quirks. Please read this before you start
  725. sending me bug reports and suggestions.
  726.  
  727.      `BUG'  = A bug that is still present.
  728.      `SUG'  = A suggestion which might be implemented in the future.
  729.      `REV'  = Revision and/or fine-tuning that still needs to be done.
  730.      `MAY'  = Maybe...
  731.  
  732.    * `BUG' - The MX class still can't be controlled by the keyboard. There is
  733.      bug in the code which seems to prevent this from working the way it
  734.      should.
  735.  
  736.    * `BUG' - The infoclass screws up computing it's minimum dimensions when
  737.      the last thing in the text is a command sequence. Should not be a real
  738.      problem since it is bullshit to end a string with a command sequence.
  739.  
  740.    * `SUG' - Automatic, aspect-ratio dependant thick-thin framing. Suggested by
  741.      Paul Weterings.
  742.  
  743.    * `SUG' - Add a method to the listview class that enables the programmer to
  744.      manipulate single entries in whichever way necessary. Suggested by Magne
  745.      Oestlyngen.
  746.  
  747.    * `SUG' - A Palette selector class. External? Suggested by Paul Weterings.
  748.  
  749.    * `REV' - `BGUI' gadgets on intuition requesters is `NOT' supported yet.
  750.  
  751.    * `REV' - The commodity class could use some cleaning up. I'm not really
  752.      satisfied with it as it is.
  753.  
  754.    * `REV' - The format of the library and class documentation files suck. I
  755.      should convert them to "real" autodoc format or amigaguide files.
  756.  
  757.    * `REV' - Error reporting. It's OK that a window failed to open or an
  758.      object failed to create but it would be nice to know why. Both numeric
  759.      and textual error descriptions should be made available.
  760.  
  761.    * `REV' - Adding method, conditional and hook notification to the window
  762.      class to. This will allow notification to happen on the application task
  763.      instead of the input.device task.
  764.  
  765.    * `REV' - Adding a method to the listview class to move entries up&down in
  766.      the list.
  767.  
  768.    * `REV' - Work on the menus. For now it is not possible to dynamically add
  769.      items, add notification or help files to the menus. This really sucks.
  770.  
  771.    * `REV' - Try to cut down on the code size. Although, all things
  772.      considering, BGUI is not excessive in size I'de like to see it smaller.
  773.  
  774.    * `MAY' - Letting the window backfill hook optionally make use of the
  775.      preferred workbench window backfill pattern or picture.
  776.  
  777.    * `MAY' - Fonts and images in the info class.
  778.  
  779.    * `MAY' - Add a posibility to "snapshot" window sizes to disk. Should this
  780.      be up to the application programmer? Suggested by Paul Weterings.
  781.  
  782.    * `MAY' - Take the layout engine of BGUI and make a seperate shared/link
  783.      library out of it. This would result in a +/- 10 KByte shared/link
  784.      library with the same functionality as the BGUI layout engine. Maybe this
  785.      will satisfy those people who are always bitching and complaining about
  786.      GUI engine libraries.
  787.  
  788. Thanks To
  789. *********
  790.  
  791.    The author would like to extend a big thank you to the following people for
  792. their valuable help:
  793.  
  794.    Bjorn Reese, Jim Cooper, Jim Karczewski, Keith Christopher, Michael
  795. Wiedmer, Michiel Willems, Magne Oestlyngen, Magnus Enarsson, Martin Bischoff,
  796. Parrish Heywood, Patrick van Beem, Paul Hill, Paul McLachlan, Paul Weterings,
  797. Per Harald Myrvang, Ranulf Doswell, Zachary A Forsyth.
  798.  
  799.    Thanks should also go to:
  800.  
  801.    * All the folks at `O.I.C'. Obvious Implementations Corporation. This
  802.      software is completely developed using DICE in the registered version and
  803.      later on the commercial version.
  804.  
  805.    * Francesco Devitt for MemLeak. A remarkable simple but very useful tool ;)
  806.  
  807.    * Reinhard Spisser and Sebastiano Vigna for their wonderful Makeinfo which
  808.      was used to generate this AmigaGuide./ASCII documentation.
  809.  
  810.    * Bryce Nesbitt and Michael Sinz for Enforcer. The best bug-hunter for the
  811.      Amiga.
  812.  
  813. Index
  814. *****
  815.  
  816. * Menu:
  817.  
  818. * Disclaimer:                           Disclaimer.
  819. * Features:                             Features.
  820. * Future:                               Future.
  821. * History:                              History.
  822. * Installation:                         Installation.
  823. * Introduction:                         Introduction.
  824. * Keyboard & Mouse:                     Keyboard & Mouse.
  825. * License:                              License.
  826. * Preface:                              Preface.
  827. * Read Me:                              Read Me.
  828. * Requirements:                         Requirements.
  829. * Thanks To:                            Thanks To.
  830. * V37.11:                               V37.11.
  831. * V37.12:                               V37.12.
  832. * V37.13:                               V37.13.
  833. * V37.14:                               V37.14.
  834. * V37.15:                               V37.15.
  835. * V37.16:                               V37.16.
  836. * V37.17:                               V37.17.
  837. * V37.18:                               V37.18.
  838. * V37.19:                               V37.19.
  839. * V37.20:                               V37.20.
  840. * V37.21:                               V37.21.
  841. * V37.22:                               V37.22.
  842. * V37.23:                               V37.23.
  843. * V37.24:                               V37.24.
  844.  
  845.